Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(ssm): Generate correct SSM Parameter ARN #1726

Merged
merged 2 commits into from
Feb 12, 2019
Merged

fix(ssm): Generate correct SSM Parameter ARN #1726

merged 2 commits into from
Feb 12, 2019

Conversation

RomainMuller
Copy link
Contributor

The SSM parameter name (resourceName portion of it's ARN) is required
to start with a /, which caused the presence of a doubled // in the generated
ARN caused by the fact sep defaults to /.

This change allows sep to be set to an empty string, allowing SSM rendering
of correct SSM parameter ARNs.

Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

@RomainMuller
fix(ssm): Generate correct SSM Parameter ARN
e30e687 
The SSM parameter name (`resourceName` portion of it's ARN) is required
to start with a `/`, which caused the presence of a doubled `//` in the generated
ARN caused by the fact `sep` defaults to `/`.

This change allows `sep` to be set to an empty string, allowing SSM rendering
of correct SSM parameter ARNs.
@RomainMuller RomainMuller requested a review from a team as a code owner February 11, 2019 13:07
eladb
eladb suggested changes Feb 11, 2019
View reviewed changes
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • missing unit test in @aws-cdk/cdk
  • how does this behave for parse?

@RomainMuller
Copy link
Contributor Author

So... the case for parse is a little awkward, because technically the separator here is /, but the SSM Parameter users would have to know that they have to re-add the / prefix to the resourceName part.

And I've added a test case for format.

@RomainMuller RomainMuller added the bug This issue is a bug. label Feb 11, 2019
@RomainMuller RomainMuller merged commit 39df456 into master Feb 12, 2019
@RomainMuller RomainMuller deleted the rmuller/fix-ssm-parameter-arn branch February 12, 2019 14:47
@RomainMuller RomainMuller added the @aws-cdk/aws-ssm Related to AWS Systems Manager label Feb 12, 2019
@rileylyman rileylyman mentioned this pull request Jun 10, 2019
Closed
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb approved these changes

Assignees
No one assigned
Labels
@aws-cdk/aws-ssm Related to AWS Systems Manager bug This issue is a bug. contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@RomainMuller @eladb @NGL321